home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sstevr.z / sstevr
Encoding:
Text File  |  2002-10-03  |  10.7 KB  |  265 lines
  1.  
  2.  
  3.  
  4. SSSSSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))                                                          SSSSSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSTEVR - compute selected eigenvalues and, optionally, eigenvectors of a
  10.      real symmetric tridiagonal matrix T
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE SSTEVR( JOBZ, RANGE, N, D, E, VL, VU, IL, IU, ABSTOL, M, W, Z,
  14.                         LDZ, ISUPPZ, WORK, LWORK, IWORK, LIWORK, INFO )
  15.  
  16.          CHARACTER      JOBZ, RANGE
  17.  
  18.          INTEGER        IL, INFO, IU, LDZ, LIWORK, LWORK, M, N
  19.  
  20.          REAL           ABSTOL, VL, VU
  21.  
  22.          INTEGER        ISUPPZ( * ), IWORK( * )
  23.  
  24.          REAL           D( * ), E( * ), W( * ), WORK( * ), Z( LDZ, * )
  25.  
  26. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  27.      These routines are part of the SCSL Scientific Library and can be loaded
  28.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  29.      directs the linker to use the multi-processor version of the library.
  30.  
  31.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  32.      4 bytes (32 bits). Another version of SCSL is available in which integers
  33.      are 8 bytes (64 bits).  This version allows the user access to larger
  34.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  35.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  36.      only one of the two versions; 4-byte integer and 8-byte integer library
  37.      calls cannot be mixed.
  38.  
  39. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  40.      SSTEVR computes selected eigenvalues and, optionally, eigenvectors of a
  41.      real symmetric tridiagonal matrix T. Eigenvalues and eigenvectors can be
  42.      selected by specifying either a range of values or a range of indices for
  43.      the desired eigenvalues.
  44.  
  45.      Whenever possible, SSTEVR calls SSTEGR to compute the
  46.      eigenspectrum using Relatively Robust Representations.  SSTEGR computes
  47.      eigenvalues by the dqds algorithm, while orthogonal eigenvectors are
  48.      computed from various "good" L D L^T representations (also known as
  49.      Relatively Robust Representations). Gram-Schmidt orthogonalization is
  50.      avoided as far as possible. More specifically, the various steps of the
  51.      algorithm are as follows. For the i-th unreduced block of T,
  52.         (a) Compute T - sigma_i = L_i D_i L_i^T, such that L_i D_i L_i^T
  53.              is a relatively robust representation,
  54.         (b) Compute the eigenvalues, lambda_j, of L_i D_i L_i^T to high
  55.             relative accuracy by the dqds algorithm,
  56.         (c) If there is a cluster of close eigenvalues, "choose" sigma_i
  57.             close to the cluster, and go to step (a),
  58.         (d) Given the approximate eigenvalue lambda_j of L_i D_i L_i^T,
  59.             compute the corresponding eigenvector by forming a
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))                                                          SSSSSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))
  71.  
  72.  
  73.  
  74.             rank-revealing twisted factorization.
  75.      The desired accuracy of the output can be specified by the input
  76.      parameter ABSTOL.
  77.  
  78.      For more details, see "A new O(n^2) algorithm for the symmetric
  79.      tridiagonal eigenvalue/eigenvector problem", by Inderjit Dhillon,
  80.      Computer Science Division Technical Report No. UCB//CSD-97-971, UC
  81.      Berkeley, May 1997.
  82.  
  83.  
  84.      Note 1 : SSTEVR calls SSTEGR when the full spectrum is requested on
  85.      machines which conform to the ieee-754 floating point standard.  SSTEVR
  86.      calls SSTEBZ and SSTEIN on non-ieee machines and
  87.      when partial spectrum requests are made.
  88.  
  89.      Normal execution of SSTEGR may create NaNs and infinities and hence may
  90.      abort due to a floating point exception in environments which do not
  91.      handle NaNs and infinities in the ieee standard default manner.
  92.  
  93.  
  94. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  95.      JOBZ    (input) CHARACTER*1
  96.              = 'N':  Compute eigenvalues only;
  97.              = 'V':  Compute eigenvalues and eigenvectors.
  98.  
  99.      RANGE   (input) CHARACTER*1
  100.              = 'A': all eigenvalues will be found.
  101.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  102.              found.  = 'I': the IL-th through IU-th eigenvalues will be found.
  103.  
  104.      N       (input) INTEGER
  105.              The order of the matrix.  N >= 0.
  106.  
  107.      D       (input/output) REAL array, dimension (N)
  108.              On entry, the n diagonal elements of the tridiagonal matrix A.
  109.              On exit, D may be multiplied by a constant factor chosen to avoid
  110.              over/underflow in computing the eigenvalues.
  111.  
  112.      E       (input/output) REAL array, dimension (N)
  113.              On entry, the (n-1) subdiagonal elements of the tridiagonal
  114.              matrix A in elements 1 to N-1 of E; E(N) need not be set.  On
  115.              exit, E may be multiplied by a constant factor chosen to avoid
  116.              over/underflow in computing the eigenvalues.
  117.  
  118.      VL      (input) REAL
  119.              VU      (input) REAL If RANGE='V', the lower and upper bounds of
  120.              the interval to be searched for eigenvalues. VL < VU.  Not
  121.              referenced if RANGE = 'A' or 'I'.
  122.  
  123.      IL      (input) INTEGER
  124.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  125.              order) of the smallest and largest eigenvalues to be returned.  1
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))                                                          SSSSSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))
  137.  
  138.  
  139.  
  140.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  141.              referenced if RANGE = 'A' or 'V'.
  142.  
  143.      ABSTOL  (input) REAL
  144.              The absolute error tolerance for the eigenvalues.  An approximate
  145.              eigenvalue is accepted as converged when it is determined to lie
  146.              in an interval [a,b] of width less than or equal to
  147.  
  148.              ABSTOL + EPS *   max( |a|,|b| ) ,
  149.  
  150.              where EPS is the machine precision.  If ABSTOL is less than or
  151.              equal to zero, then  EPS*|T|  will be used in its place, where
  152.              |T| is the 1-norm of the tridiagonal matrix obtained by reducing
  153.              A to tridiagonal form.
  154.  
  155.              See "Computing Small Singular Values of Bidiagonal Matrices with
  156.              Guaranteed High Relative Accuracy," by Demmel and Kahan, LAPACK
  157.              Working Note #3.
  158.  
  159.              If high relative accuracy is important, set ABSTOL to SLAMCH(
  160.              'Safe minimum' ).  Doing so will guarantee that eigenvalues are
  161.              computed to high relative accuracy when possible in future
  162.              releases.  The current code does not make any guarantees about
  163.              high relative accuracy, but future releases will. See J. Barlow
  164.              and J. Demmel, "Computing Accurate Eigensystems of Scaled
  165.              Diagonally Dominant Matrices", LAPACK Working Note #7, for a
  166.              discussion of which matrices define their eigenvalues to high
  167.              relative accuracy.
  168.  
  169.      M       (output) INTEGER
  170.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  171.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  172.  
  173.      W       (output) REAL array, dimension (N)
  174.              The first M elements contain the selected eigenvalues in
  175.              ascending order.
  176.  
  177.      Z       (output) REAL array, dimension (LDZ, max(1,M) )
  178.              If JOBZ = 'V', then if INFO = 0, the first M columns of Z contain
  179.              the orthonormal eigenvectors of the matrix A corresponding to the
  180.              selected eigenvalues, with the i-th column of Z holding the
  181.              eigenvector associated with W(i).  Note: the user must ensure
  182.              that at least max(1,M) columns are supplied in the array Z; if
  183.              RANGE = 'V', the exact value of M is not known in advance and an
  184.              upper bound must be used.
  185.  
  186.      LDZ     (input) INTEGER
  187.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  188.              'V', LDZ >= max(1,N).
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. SSSSSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))                                                          SSSSSSSSTTTTEEEEVVVVRRRR((((3333SSSS))))
  203.  
  204.  
  205.  
  206.      ISUPPZ  (output) INTEGER array, dimension ( 2*max(1,M) )
  207.              The support of the eigenvectors in Z, i.e., the indices
  208.              indicating the nonzero elements in Z. The i-th eigenvector is
  209.              nonzero only in elements ISUPPZ( 2*i-1 ) through ISUPPZ( 2*i ).
  210.  
  211.      WORK    (workspace/output) REAL array, dimension (LWORK)
  212.              On exit, if INFO = 0, WORK(1) returns the optimal (and minimal)
  213.              LWORK.
  214.  
  215.      LWORK   (input) INTEGER
  216.              The dimension of the array WORK.  LWORK >= 20*N.
  217.  
  218.              If LWORK = -1, then a workspace query is assumed; the routine
  219.              only calculates the optimal size of the WORK array, returns this
  220.              value as the first entry of the WORK array, and no error message
  221.              related to LWORK is issued by XERBLA.
  222.  
  223.      IWORK   (workspace/output) INTEGER array, dimension (LIWORK)
  224.              On exit, if INFO = 0, IWORK(1) returns the optimal (and minimal)
  225.              LIWORK.
  226.  
  227.      LIWORK  (input) INTEGER
  228.              The dimension of the array IWORK.  LIWORK >= 10*N.
  229.  
  230.              If LIWORK = -1, then a workspace query is assumed; the routine
  231.              only calculates the optimal size of the IWORK array, returns this
  232.              value as the first entry of the IWORK array, and no error message
  233.              related to LIWORK is issued by XERBLA.
  234.  
  235.      INFO    (output) INTEGER
  236.              = 0:  successful exit
  237.              < 0:  if INFO = -i, the i-th argument had an illegal value
  238.              > 0:  Internal error
  239.  
  240. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  241.      Based on contributions by
  242.         Inderjit Dhillon, IBM Almaden, USA
  243.         Osni Marques, LBNL/NERSC, USA
  244.         Ken Stanley, Computer Science Division, University of
  245.           California at Berkeley, USA
  246.  
  247.  
  248. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  249.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  250.  
  251.      This man page is available only online.
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.